test/util/analytics.js (2)

4-20: Consider using globalThis for better compatibility.

SonarCloud flags the use of global over globalThis. While global works in Node.js, globalThis is the standardized way to access the global object across environments.

♻️ Suggested refactor

 function withImmediateTimers(cb) {
-  const originalSetTimeout = global.setTimeout;
-  const originalClearTimeout = global.clearTimeout;
+  const originalSetTimeout = globalThis.setTimeout;
+  const originalClearTimeout = globalThis.clearTimeout;

-  global.setTimeout = (fn) => {
+  globalThis.setTimeout = (fn) => {
     fn();
     return 1;
   };
-  global.clearTimeout = () => {};
+  globalThis.clearTimeout = () => {};

   try {
     cb();
   } finally {
-    global.setTimeout = originalSetTimeout;
-    global.clearTimeout = originalClearTimeout;
+    globalThis.setTimeout = originalSetTimeout;
+    globalThis.clearTimeout = originalClearTimeout;
   }
 }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/util/analytics.js` around lines 4 - 20, The helper withImmediateTimers
uses Node-specific global instead of standardized globalThis; update all
references to global (e.g., global.setTimeout, global.clearTimeout,
originalSetTimeout, originalClearTimeout) to use globalThis so the function
operates across environments: capture original functions from globalThis,
override globalThis.setTimeout/globalThis.clearTimeout inside the function, and
restore them in the finally block.

---

61-116: Good test coverage for core interceptor behavior.

The tests cover the happy path, non-string return fallback, and exception fallback scenarios. Consider adding tests for the click analytics path to ensure full coverage.

💡 Additional test suggestion

it('should modify keyword for click analytics', () => {
  const sentEvents = [];
  analytics.setAnalyticsKeywordInterceptor(({ action, keyword }) => 
    action === 'click' ? `clicked:${keyword}` : keyword
  );

  const client = {
    sendStatsEvent: (action, keyword, payload) => sentEvents.push({ action, keyword, payload }),
    getSettings: () => ({ paging: { pageSize: 10 }, keyword: 'test' })
  };
  
  // Test addClickTrackers / onLinkClick behavior
});

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@test/util/analytics.js` around lines 61 - 116, Add a unit test covering the
click analytics path: register an interceptor with
analytics.setAnalyticsKeywordInterceptor that changes keywords only for action
=== 'click', create a fake client with sendStatsEvent and getSettings (returning
paging and keyword), then either call analytics.sendClickStats(client,
'Original', ...) or wire up analytics.addClickTrackers and invoke the
onLinkClick handler to simulate a click; assert that the sent event's action ===
'click' and that the keyword was transformed (e.g., 'clicked:Original') while
non-click actions remain unchanged.

README.md (1)

1119-1129: Documentation example could show full event object structure.

The example is functional, but the interceptor actually receives { action, keyword, payload } per the implementation. Consider expanding the example to show the full signature available to users, which would help them leverage all available context.

analyticsKeywordInterceptor: function (event) {
  // event contains: { action, keyword, payload }
  // action: 'search' | 'click'
  // payload: contains contextual data like numberOfResults, documentId, etc.
  return event.keyword.replace(/\+?\d[\d\s().-]{6,}\d/g, '[REDACTED]');
}

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 1119 - 1129, The README example for
analyticsKeywordInterceptor shows only a string input but the interceptor
actually receives an object ({ action, keyword, payload }); update the example
usage of analyticsKeywordInterceptor to use a full event object parameter name
and document the fields (action, keyword, payload) and example payload
properties (e.g., numberOfResults, documentId) so users can access contextual
data when modifying keywords; refer to analyticsKeywordInterceptor, the event
parameter, and its action/keyword/payload properties when editing the example
text and comments.

src/util/analytics.js (1)

44-46: Consider logging interceptor errors in debug mode.

The empty catch block silently swallows errors, which is correct for production resilience but could make debugging difficult for developers implementing custom interceptors. Consider adding a console warning when debug mode is enabled.

🔧 Suggested improvement

   } catch (e) {
-    // Keep original keyword on interceptor failure
+    // Keep original keyword on interceptor failure
+    if (typeof console !== 'undefined' && console.warn) {
+      console.warn('analyticsKeywordInterceptor threw an error:', e);
+    }
   }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@src/util/analytics.js` around lines 44 - 46, In src/util/analytics.js update
the empty catch (e) block so it still swallows errors in production but emits a
debug-level warning when debug mode is enabled: detect the module's debug flag
(e.g., process.env.DEBUG, an options.debug value, or the existing analytics
debug/logging facility) and call console.warn or the module logger to print the
interceptor error and context (include the caught error e and the
keyword/interceptor name) only when debug is true; leave the swallow behavior
unchanged otherwise.